This is an extension library that only has a peer dependency to piral-core
. What piral-menu
brings to the table is a set of API extensions that can be used with piral
or piral-core
to bring a simplified menu integration from your pilets to your Piral instance.
Documentation
For details on the provided API check out the documentation at the Piral website or on GitHub.
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createMenuApi
from the piral-menu
package.
import { createMenuApi } from 'piral-menu';
The integration looks like:
const instance = createInstance({
extendApi: [createMenuApi()],
});
Via the options the defaultSettings
and the global / initially available menu items
can be defined.
For example:
const instance = createInstance({
extendApi: [createMenuApi({
defaultSettings: {
type: 'admin',
},
items: [
{
component: HomeMenuItem,
},
],
})],
});
License
Piral is released using the MIT license. For more information see the license file.